Skip to content

[ContainerInstance] Fix TypeSpec validation: correct property name in source example file#42820

Open
MicroJamesLim wants to merge 49 commits into
mainfrom
user/jameslim/aci-azmi-api-2026-05-01
Open

[ContainerInstance] Fix TypeSpec validation: correct property name in source example file#42820
MicroJamesLim wants to merge 49 commits into
mainfrom
user/jameslim/aci-azmi-api-2026-05-01

Conversation

@MicroJamesLim

@MicroJamesLim MicroJamesLim commented May 1, 2026

Copy link
Copy Markdown
Contributor

ARM (Control Plane) API Specification Update Pull Request

Tip

Overwhelmed by all this guidance? See the Getting help section at the bottom of this PR description.

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

spec_pr_review_workflow_diagram

Purpose of this PR

What's the purpose of this PR? Check the specific option that applies. This is mandatory!

  • New resource provider.
  • New API version for an existing resource provider. (If API spec is not defined in TypeSpec, the PR should have been created in adherence to OpenAPI specs PR creation guidance).
  • Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
  • Update existing version to fix OpenAPI spec quality issues in S360.
  • Convert existing OpenAPI spec to TypeSpec spec (do not combine this with implementing changes for a new API version).
  • Other, please clarify:
    • edit this with your clarification

Due diligence checklist

To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:

  • I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
  • I have reviewed following Resource Provider guidelines, including
    ARM resource provider contract and
    REST guidelines (estimated time: 4 hours).
    I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR.
  • A release plan has been created. If not, please create one as it will help guide you through the REST API and SDK creation process.

Additional information

This PR fixes the failing TypeSpec Validation CI job for the ContainerInstance 2026-07-01 stable API version.

Root cause: The TypeSpec source example file examples/2026-07-01/ContainerGroupsCreateOrUpdateManagedIdentityAzureFileshare.json used the property name userManagedIdentityClientId, while the TypeSpec model (models.tsp) and the generated swagger definition (containerInstance.json) define the property as userAssignedIdentityClientId. When tsp compile ran in CI, it copied the source example value (userManagedIdentityClientId) into the generated output file, producing a diff against the committed file and triggering the "files have been changed after tsp compile" validation failure.

Fix: Updated the source example file to use userAssignedIdentityClientId (matching the TypeSpec model property name and the swagger definition), so tsp compile now generates output consistent with the committed file — no diff, no failure.

Files changed:

  • specification/containerinstance/resource-manager/Microsoft.ContainerInstance/ContainerInstance/examples/2026-07-01/ContainerGroupsCreateOrUpdateManagedIdentityAzureFileshare.json — replaced userManagedIdentityClientId with userAssignedIdentityClientId (3 occurrences)
Viewing API changes

For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.

Suppressing failures

If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
suppressions guide to get approval.

Getting help

  • First, please carefully read through this PR description, from top to bottom. Please fill out the Purpose of this PR and Due diligence checklist.
  • If you don't have permissions to remove or add labels to the PR, request write access per aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories
  • To understand what you must do next to merge this PR, see the Next Steps to Merge comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.
  • For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
    and https://aka.ms/ci-fix.
  • For help with ARM review (PR workflow diagram Step 2), see https://aka.ms/azsdk/pr-arm-review.
  • If the PR CI checks appear to be stuck in queued state, please add a comment with contents /azp run.
    This should result in a new comment denoting a PR validation pipeline has started and the checks should be updated after few minutes.
  • If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.
  • For guidance on SDK breaking change review, refer to https://aka.ms/ci-fix.

Co-authored-by: Copilot <copilot@github.com>
@github-actions

github-actions Bot commented May 1, 2026

Copy link
Copy Markdown

Next Steps to Merge

Next steps that must be taken to merge this PR:
  • ❌ This PR targets either the main branch of the public specs repo or the RPSaaSMaster branch of the private specs repo. These branches are not intended for iterative development. Therefore, you must acknowledge you understand that after this PR is merged, the APIs are considered shipped to Azure customers. Any further attempts at in-place modifications to the APIs will be subject to Azure's versioning and breaking change policies. Additionally, for control plane APIs, you must acknowledge that you are following all the best practices documented by ARM at aka.ms/armapibestpractices. If you do intend to release the APIs to your customers by merging this PR, add the PublishToCustomers label to your PR in acknowledgement of the above. Otherwise, retarget this PR onto a feature branch, i.e. with prefix release- (see aka.ms/azsdk/api-versions#release--branches).


Comment generated by summarize-checks workflow run.

@github-actions github-actions Bot added ARMReview new-api-version resource-manager TypeSpec Authored with TypeSpec WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels May 1, 2026
@github-actions

github-actions Bot commented May 1, 2026

Copy link
Copy Markdown

API Change Check

APIView identified API level changes in this PR and created the following API reviews

Language API Review for Package
Swagger Microsoft.ContainerInstance-ContainerInstance
Go sdk/resourcemanager/containerinstance/armcontainerinstance
Python azure-mgmt-containerinstance
JavaScript @azure/arm-containerinstance
C# Azure.ResourceManager.ContainerInstance
Java com.azure.resourcemanager:azure-resourcemanager-containerinstance
TypeSpec Microsoft.ContainerInstance

Comment generated by After APIView workflow run.

@sandipsh

sandipsh commented May 1, 2026

Copy link
Copy Markdown
Contributor

please address lintdiff, model validation, prettier and typespec validation errors.

@sandipsh sandipsh added ARMChangesRequested and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels May 1, 2026
@github-actions github-actions Bot added ARMAutoSignedOff-IncrementalTSP ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review and removed ARMChangesRequested labels May 18, 2026
Copilot AI and others added 2 commits May 20, 2026 20:55
…gState type definition in containerInstance.json

Co-authored-by: MicroJamesLim <125409279+MicroJamesLim@users.noreply.github.com>
Copilot AI changed the title [ContainerInstance] Fix Swagger LintDiff failure for 2026-07-01 by adding missing x-ms-pageable [containerinstance] Fix TypeSpec validation: remove readOnly from SandboxGroupProvisioningState type definition Jun 10, 2026
Copilot AI changed the title [containerinstance] Fix TypeSpec validation: remove readOnly from SandboxGroupProvisioningState type definition [containerinstance] Fix Swagger LintDiff - Analyze Code for 2026-07-01 Jun 11, 2026
…edIdentityClientId in example

Co-authored-by: MicroJamesLim <125409279+MicroJamesLim@users.noreply.github.com>
Copilot AI changed the title [containerinstance] Fix Swagger LintDiff - Analyze Code for 2026-07-01 [ContainerInstance] Fix ModelValidation: correct userManagedIdentityClientId to userAssignedIdentityClientId in 2026-07-01 example Jun 12, 2026
…ntityClientId

Co-authored-by: MicroJamesLim <125409279+MicroJamesLim@users.noreply.github.com>
Copilot AI changed the title [ContainerInstance] Fix ModelValidation: correct userManagedIdentityClientId to userAssignedIdentityClientId in 2026-07-01 example [ContainerInstance] Fix TypeSpec validation: correct property name in source example file Jun 12, 2026
@MicroJamesLim MicroJamesLim requested a review from ravimeda June 12, 2026 17:08
@MicroJamesLim MicroJamesLim added WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required and removed ARMChangesRequested labels Jun 12, 2026
@sandipsh sandipsh added Approved-Suppression and removed SuppressionReviewRequired WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Jun 12, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants